<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>PagingResource xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/name/pehl/taoki/rest/paging/PagingResource.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> name.pehl.taoki.<strong class="jxr_keyword">rest</strong>.paging;
<a name="2" href="#2">2</a>   
<a name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.util.Map;
<a name="4" href="#4">4</a>   
<a name="5" href="#5">5</a>   <strong class="jxr_keyword">import</strong> org.restlet.Request;
<a name="6" href="#6">6</a>   <strong class="jxr_keyword">import</strong> org.restlet.resource.ServerResource;
<a name="7" href="#7">7</a>   
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment">/**</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * Basisklasse für REST Resourcen, die Paging unterstützen. Die</em>
<a name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * Paginginformationen müssen in der URL folgendermaßen angegeben werden:&lt;br/&gt;</em>
<a name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/" target="alexandria_uri">http://server/resource/</a>{offset}/{limit}[/{sortField}[/{sortDir}]]&lt;/code&gt;</em>
<a name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> * Wenn Paging verwendet werden soll, dann müssen die Attribute</em>
<a name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;offset&lt;/code&gt; und &lt;code&gt;limit&lt;/code&gt; zwingend angegeben werden. Die</em>
<a name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * Attribute &lt;code&gt;sortField&lt;/code&gt; und &lt;code&gt;sortDir&lt;/code&gt; sind optional. Das</em>
<a name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * Attribut &lt;code&gt;sortDir&lt;/code&gt; ist nur in Verbindung mit dem Attribut</em>
<a name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;sortField&lt;/code&gt; gültig.</em>
<a name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * Hier die Bedeutung der einzelnen Attribute:</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;&lt;code&gt;offset&lt;/code&gt;&lt;br/&gt;</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * Der Offset für das Paging (muß zwischen {@link PageInfo#MIN_OFFSET} und</em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * {@link PageInfo#MAX_OFFSET} liegen)&lt;/li&gt;</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;&lt;code&gt;limit&lt;/code&gt;&lt;br/&gt;</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * Das Limit (PageSize) für das Paging (muß zwischen {@link PageInfo#MIN_LIMIT}</em>
<a name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * und {@link PageInfo#MAX_LIMIT} liegen)&lt;/li&gt;</em>
<a name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;&lt;code&gt;sortField&lt;/code&gt;&lt;br/&gt;</em>
<a name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * Der Name des Feldes nach dem sortiert werden soll&lt;/li&gt;</em>
<a name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;&lt;code&gt;sortDir&lt;/code&gt;&lt;br/&gt;</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * Die Sortierrichtung (muss einem der Konstanten aus {@link SortDir}</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * entsprechen, wobei Groß/Kleinschreibung keine Rolle spielt)&lt;/li&gt;</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * Im folgenden einige Beispiele gültiger und fehlerhafter URLs:</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * &lt;ol&gt;</em>
<a name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Gültige URLs&lt;br/&gt;</em>
<a name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/0/50&lt;/code&gt;" target="alexandria_uri">http://server/resource/0/50&lt;/code&gt;</a> &lt;br/&gt;</em>
<a name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/10/20/none&lt;/code&gt;&lt;br/&gt;" target="alexandria_uri">http://server/resource/10/20/none&lt;/code&gt;&lt;br/&gt;</a></em>
<a name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/100/50/vorname&lt;/code&gt;&lt;br/&gt;" target="alexandria_uri">http://server/resource/100/50/vorname&lt;/code&gt;&lt;br/&gt;</a></em>
<a name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/1/2/vorname/asc&lt;/code&gt;&lt;br/&gt;" target="alexandria_uri">http://server/resource/1/2/vorname/asc&lt;/code&gt;&lt;br/&gt;</a></em>
<a name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/1/2/plz/dESc&lt;/code&gt;&lt;/li&gt;" target="alexandria_uri">http://server/resource/1/2/plz/dESc&lt;/code&gt;&lt;/li&gt;</a></em>
<a name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Fehlerhafte URLs&lt;br/&gt;</em>
<a name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/-1/50&lt;/code&gt;" target="alexandria_uri">http://server/resource/-1/50&lt;/code&gt;</a> &lt;br/&gt;</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/100/0&lt;/code&gt;&lt;br/&gt;" target="alexandria_uri">http://server/resource/100/0&lt;/code&gt;&lt;br/&gt;</a></em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/100/50/desc&lt;/code&gt;" target="alexandria_uri">http://server/resource/100/50/desc&lt;/code&gt;</a> (syntaktisch zwar korrekt,</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * aber es wird hier versucht nach dem &lt;i&gt;Feld&lt;/i&gt; &lt;code&gt;desc&lt;/code&gt; zu</em>
<a name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * sortieren)&lt;br/&gt;</em>
<a name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;<a href="http://server/resource/10/20/nachname/sonicht&lt;/code&gt;&lt;/li&gt;" target="alexandria_uri">http://server/resource/10/20/nachname/sonicht&lt;/code&gt;&lt;/li&gt;</a></em>
<a name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * &lt;/ol&gt;</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * Falls die Attribute &lt;code&gt;offset&lt;/code&gt; und &lt;code&gt;limit&lt;/code&gt; außerhalb des</em>
<a name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * gültigen Wertebereich liegen, werden Sie mit den Minimal- bzw. Maximalwert</em>
<a name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * initialisiert.&lt;br/&gt;</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * Falls für &lt;code&gt;offset&lt;/code&gt; und &lt;code&gt;limit&lt;/code&gt; keine gültigen Zahlen</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * angegeben wurden, oder die Anzahl der Attribute nicht stimmt, liefert die</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * Methode {@link #getPageInfo(Request)} &lt;code&gt;null&lt;/code&gt;.</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> * </em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> * @author $Author: lfstad-pehl $</em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> * @version $Date: 2009-01-21 11:32:14 +0100 (Mi, 21 Jan 2009) $ $Revision:</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> *          61416 $</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> */</em>
<a name="68" href="#68">68</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PagingResource.html">PagingResource</a> <strong class="jxr_keyword">extends</strong> ServerResource
<a name="69" href="#69">69</a>  {
<a name="70" href="#70">70</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String OFFSET_ATTRIBUTE = <span class="jxr_string">"offset"</span>;
<a name="71" href="#71">71</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LIMIT_ATTRIBUTE = <span class="jxr_string">"limit"</span>;
<a name="72" href="#72">72</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SORTFIELD_ATTRIBUTE = <span class="jxr_string">"sortField"</span>;
<a name="73" href="#73">73</a>      <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SORTDIR_ATTRIBUTE = <span class="jxr_string">"sortDir"</span>;
<a name="74" href="#74">74</a>  
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <em class="jxr_javadoccomment">/**</em>
<a name="77" href="#77">77</a>  <em class="jxr_javadoccomment">     * Prüft den Request auf Paging Attribute und liefert die entsprechende</em>
<a name="78" href="#78">78</a>  <em class="jxr_javadoccomment">     * {@link PageInfo} Instanz oder &lt;code&gt;null&lt;/code&gt;, falls für</em>
<a name="79" href="#79">79</a>  <em class="jxr_javadoccomment">     * &lt;code&gt;offset&lt;/code&gt; und &lt;code&gt;limit&lt;/code&gt; keine gültigen Zahlen</em>
<a name="80" href="#80">80</a>  <em class="jxr_javadoccomment">     * angegeben wurden, oder die Anzahl der Attribute nicht stimmt.</em>
<a name="81" href="#81">81</a>  <em class="jxr_javadoccomment">     * </em>
<a name="82" href="#82">82</a>  <em class="jxr_javadoccomment">     * @param request</em>
<a name="83" href="#83">83</a>  <em class="jxr_javadoccomment">     *            Der Request der Resource</em>
<a name="84" href="#84">84</a>  <em class="jxr_javadoccomment">     * @return Eine {@link PageInfo} Instanz mit den im Request gemachten</em>
<a name="85" href="#85">85</a>  <em class="jxr_javadoccomment">     *         Attrbuten bzw. &lt;code&gt;null&lt;/code&gt;, falls für &lt;code&gt;offset&lt;/code&gt;</em>
<a name="86" href="#86">86</a>  <em class="jxr_javadoccomment">     *         und &lt;code&gt;limit&lt;/code&gt; keine gültigen Zahlen angegeben wurden,</em>
<a name="87" href="#87">87</a>  <em class="jxr_javadoccomment">     *         oder die Anzahl der Attribute nicht stimmt.</em>
<a name="88" href="#88">88</a>  <em class="jxr_javadoccomment">     */</em>
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">protected</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a> getPageInfo(Request request)
<a name="90" href="#90">90</a>      {
<a name="91" href="#91">91</a>          Map&lt;String, Object&gt; attributes = request.getAttributes();
<a name="92" href="#92">92</a>          String offset = (String) attributes.get(OFFSET_ATTRIBUTE);
<a name="93" href="#93">93</a>          String limit = (String) attributes.get(LIMIT_ATTRIBUTE);
<a name="94" href="#94">94</a>          String sortField = (String) attributes.get(SORTFIELD_ATTRIBUTE);
<a name="95" href="#95">95</a>          String sortDir = (String) attributes.get(SORTDIR_ATTRIBUTE);
<a name="96" href="#96">96</a>  
<a name="97" href="#97">97</a>          <em class="jxr_comment">// Nur dann ein PageInfo zurückgegeben, wenn Offset und Limit</em>
<a name="98" href="#98">98</a>          <em class="jxr_comment">// angegeben wurden</em>
<a name="99" href="#99">99</a>          <strong class="jxr_keyword">if</strong> (offset == <strong class="jxr_keyword">null</strong> || limit == <strong class="jxr_keyword">null</strong>)
<a name="100" href="#100">100</a>         {
<a name="101" href="#101">101</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="102" href="#102">102</a>         }
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>         <em class="jxr_comment">// Konvertiere Offset</em>
<a name="105" href="#105">105</a>         Integer offsetValue = convert(request, offset, <span class="jxr_string">"offset"</span>);
<a name="106" href="#106">106</a>         <strong class="jxr_keyword">if</strong> (offsetValue == <strong class="jxr_keyword">null</strong>)
<a name="107" href="#107">107</a>         {
<a name="108" href="#108">108</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="109" href="#109">109</a>         }
<a name="110" href="#110">110</a> 
<a name="111" href="#111">111</a>         <em class="jxr_comment">// Konvertiere Limit</em>
<a name="112" href="#112">112</a>         Integer limitValue = convert(request, limit, <span class="jxr_string">"limit"</span>);
<a name="113" href="#113">113</a>         <strong class="jxr_keyword">if</strong> (limitValue == <strong class="jxr_keyword">null</strong>)
<a name="114" href="#114">114</a>         {
<a name="115" href="#115">115</a>             <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="116" href="#116">116</a>         }
<a name="117" href="#117">117</a> 
<a name="118" href="#118">118</a>         <em class="jxr_comment">// Konvertiere Sortierungs-Attribute</em>
<a name="119" href="#119">119</a>         <a href="../../../../../name/pehl/taoki/rest/paging/SortDir.html">SortDir</a> sortDirValue = SortDir.NONE;
<a name="120" href="#120">120</a>         <strong class="jxr_keyword">if</strong> (sortDir != <strong class="jxr_keyword">null</strong>)
<a name="121" href="#121">121</a>         {
<a name="122" href="#122">122</a>             <strong class="jxr_keyword">try</strong>
<a name="123" href="#123">123</a>             {
<a name="124" href="#124">124</a>                 sortDirValue = SortDir.valueOf(sortDir.toUpperCase());
<a name="125" href="#125">125</a>             }
<a name="126" href="#126">126</a>             <strong class="jxr_keyword">catch</strong> (IllegalArgumentException iae)
<a name="127" href="#127">127</a>             {
<a name="128" href="#128">128</a>                 getLogger().severe(
<a name="129" href="#129">129</a>                         <span class="jxr_string">"Kann Attribute 'sortDir' nicht aus "</span> + request.getResourceRef()
<a name="130" href="#130">130</a>                                 + <span class="jxr_string">" lesen: Bitte eine gueltige Konstante ("</span> + SortDir.values() + <span class="jxr_string">") angeben."</span>);
<a name="131" href="#131">131</a>                 <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a name="132" href="#132">132</a>             }
<a name="133" href="#133">133</a>         }
<a name="134" href="#134">134</a> 
<a name="135" href="#135">135</a>         <em class="jxr_comment">// PageInfo erstellen und zurückgeben</em>
<a name="136" href="#136">136</a>         <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../name/pehl/taoki/rest/paging/PageInfo.html">PageInfo</a>(offsetValue, limitValue, <strong class="jxr_keyword">new</strong> <a href="../../../../../name/pehl/taoki/rest/paging/SortInfo.html">SortInfo</a>(sortField, sortDirValue));
<a name="137" href="#137">137</a>     }
<a name="138" href="#138">138</a> 
<a name="139" href="#139">139</a> 
<a name="140" href="#140">140</a>     <strong class="jxr_keyword">private</strong> Integer convert(Request request, String value, String name)
<a name="141" href="#141">141</a>     {
<a name="142" href="#142">142</a>         Integer convertedValue = <strong class="jxr_keyword">null</strong>;
<a name="143" href="#143">143</a>         <strong class="jxr_keyword">try</strong>
<a name="144" href="#144">144</a>         {
<a name="145" href="#145">145</a>             convertedValue = <strong class="jxr_keyword">new</strong> Integer(value);
<a name="146" href="#146">146</a>         }
<a name="147" href="#147">147</a>         <strong class="jxr_keyword">catch</strong> (NumberFormatException nfe)
<a name="148" href="#148">148</a>         {
<a name="149" href="#149">149</a>             getLogger().severe(
<a name="150" href="#150">150</a>                     <span class="jxr_string">"Kann Attribut '"</span> + name + <span class="jxr_string">"' nicht aus "</span> + request.getResourceRef()
<a name="151" href="#151">151</a>                             + <span class="jxr_string">" lesen: Bitte eine gueltige Zahl angeben."</span>);
<a name="152" href="#152">152</a>         }
<a name="153" href="#153">153</a>         <strong class="jxr_keyword">return</strong> convertedValue;
<a name="154" href="#154">154</a>     }
<a name="155" href="#155">155</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

